Skip to main content

ARDK for Android/com.nianticlabs.ardk/WPSError

WPSError

[androidJvm]
enum WPSError : Enum<WPSError> , ErrorCodeProvider

Represents the current error status of the WPS (World Positioning System) feature.

These error codes indicate specific issues that may prevent WPS from providing accurate positioning data. Applications should check for these errors and provide appropriate feedback to users.

Entries​

NONE[androidJvm]
NONE
No error - WPS is operating normally.
NO_GNSS[androidJvm]
NO_GNSS
No GPS data has been provided to the system.
TRACKING_FAILED[androidJvm]
TRACKING_FAILED
WPS tracking has failed.
NO_HEADING[androidJvm]
NO_HEADING
No compass data has been provided to the system.
NOT_INITIALIZED[androidJvm]
NOT_INITIALIZED
WPS has not yet finished initializing.
UNKNOWN_ERROR[androidJvm]
UNKNOWN_ERROR
An unknown error occurred.

Types​

NameSummary
Companion[androidJvm]
object Companion : ErrorFactory<WPSError>

Properties​

NameSummary
entries[androidJvm]
val entries: EnumEntries<WPSError>
Returns a representation of an immutable list of all enum entries, in the order they're declared.
name[androidJvm]
val name: String
ordinal[androidJvm]
val ordinal: Int
value[androidJvm]
val value: Int

Functions​

NameSummary
valueOf[androidJvm]
fun valueOf(value: String): WPSError
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
values[androidJvm]
fun values(): Array<WPSError>
Returns an array containing the constants of this enum type, in the order they're declared.